home *** CD-ROM | disk | FTP | other *** search
/ Aminet 6 / Aminet 6 - June 1995.iso / Aminet / comm / tcp / clchat37.lha / CLChat37 / CLChatServer.DOC < prev    next >
Encoding:
Text File  |  1995-03-22  |  10.4 KB  |  298 lines
  1. CLChatSystem 3.7 for AmiTCP
  2. ---------------------------
  3.  
  4. (1) Copyrights
  5.  
  6.     The CLChatServer, the CLChatD, CLChatLink and the CLChatGUI are
  7.     Copyright (C) 1994-1995 Oliver Wagner (o.wagner@pluribus.wupper.de)
  8.     All Rights Reserved.
  9.  
  10.     The files are freely distributable as long as no modifications are
  11.     made to any part of the package and all files are distributed in
  12.     a single archive, accompanied by this documentation file.
  13.  
  14.     CLChatGUI is a MUI application. MUI is (C) 1993-1995 Stefan Stuntz.
  15.  
  16.     AmiTCP is (C) 1994-95 NSDI Inc.
  17.  
  18.  
  19. (2) Overview
  20.  
  21.     This is a multi-user multi-channel chat system somewhat based on
  22.     IRC. It features:
  23.  
  24.     o unlimited number of users
  25.     o unlimited number of channels
  26.     o private messaging
  27.     o automatic user identification
  28.     o flood protection
  29.     o NEW: user banning
  30.     o NEW: multiple server capability with loop protection
  31.     o channel operator privileges for setting channel topics
  32.       and removing users from a channel
  33.     o chat operator privilege for global channel operator status
  34.       and removing users from chat completely
  35.  
  36.     The user frontend for the chat is a comfortable GUI client
  37.     providing
  38.  
  39.     o easy user & channel operations
  40.     o input history
  41.     o automatic notifications of certain events via Deiconification
  42.       or beep
  43.     o builtin ARexx-Port
  44.     o NEW: Dialog windows for direct user<->user communication
  45.     o NEW: direct file transfers to remote users via IP
  46.  
  47.  
  48. (3) Origin
  49.  
  50.     The Chatsystem is originally part of the Connectline/Amiga BBS
  51.     package which features an ANSI text client for online usage
  52.     and the possibility to login to the chat during Hydra file 
  53.     transfers. The standlone ChatServer and the GUI client are
  54.     only a subset of the whole package.
  55.  
  56.     Write to Connectline@pluribus.wupper.de for more information
  57.     about Connectline.
  58.  
  59.  
  60. (4) Server Installation
  61.  
  62.     Copy the CLChatServer to AmiTCP:bin
  63.     Copy the CLChatLink to AmiTCP:bin
  64.     Copy the CLChatD to AmiTCP:serv
  65.  
  66.     Add the following line to AmiTCP:db/services:
  67.     clchat/5555
  68.  
  69.     Add the following line to AmiTCP:db/InetD.conf:
  70.     clchat    stream      tcp nowait root amitcp:serv/clchatd
  71.  
  72.     Add the following line to AmiTCP:bin/startnet:
  73.     run >NIL: AmiTCP:bin/CLChatServer
  74.  
  75.     Optionally create a file named AmiTCP:db/ChatServer.MOTD
  76.     containing a text file which will be display to each new user
  77.     logging into the chat.
  78.  
  79.     Optionally create a file named AmiTCP:db/ChatServer.OPList
  80.     containing a list of users which have the "Chat Operator"
  81.     privilege. These users automatically receive channel operator
  82.     status for every channel they join and can use the hidden
  83.     server command "/KILL" to remove other users from the
  84.     chat server. They may also the "/NETINFO" command to inquiry
  85.     chat network information, and use the BAN commands to list,
  86.     add or remove user bans.
  87.     This file contains entries of the following form:
  88.     Nickname Netaddress
  89.     For example:
  90.     Olli olli@lsd.wupper.de
  91.  
  92.     Optionally create a file named AmiTCP:db/ChatServer.Servers
  93.     containing a list of remote servers allowed to connect to your
  94.     server. This file contains a list of FQDN addresses or a
  95.     standard AmigaDOS wildcard matching FQDN addresses. If this
  96.     file is missing, all servers are allowed to connect.
  97.     If you want to ban a single server only, you can add a
  98.     exclusive pattern. For example, to ban server "lsd.wupper.de"
  99.     only, add the line
  100.     ~(lsd.wupper.de)
  101.     The first line of the file may contain a number specifying
  102.     the maximum number of servers to connect. This defaults to 8.
  103.  
  104.     You can make CLChatD and CLChatLink resident to increase
  105.     startup speed and reduce memory usage; this might proof
  106.     useful if you run or accept several connections.
  107.  
  108.  
  109. (5) Client installation
  110.  
  111.     No installation required, simply run the Client from either
  112.     Shell or Workbench. It will prompt for your user information
  113.     and the server to connect to. See the Client guide for
  114.     more information about using it.
  115.  
  116.  
  117. (6) Using the server
  118.  
  119.     Using the server should be quite self-explainatory. Use the
  120.     command "/?" to obtain a list of available commands.
  121.  
  122.     Channels are created automatically when a users joins
  123.     and removed when the last user leaves. There is a
  124.     persistant default channel called MAIN on which every
  125.     new users starts. The first user entering a channel
  126.     will obtain channel operator status. He may change
  127.     the topic, kick other users, give or remove channel
  128.     operator status from them.
  129.  
  130.     Specifc users may be banned from a server using the
  131.     /BANADD command which is available to chat operators only.
  132.     Bans are stored in the file "AmiTCP:DB/ChatServer.UserBans"
  133.     and contain FQDN addresses or a AmigaDOS wildcard matching
  134.     FQDN addresses. You may want to use wildcards of the form
  135.     "#?@machine" because the user part of addresses is generally
  136.     the same as the nickname which may be set by the user.
  137.     For example, to ban users from lsd.wupper.de, use the
  138.     entry
  139.     #?@lsd.wupper.de
  140.  
  141.     Note that adding a line "#?" will make you quite lonely
  142.     on your server.
  143.  
  144.     The server respons to three shell signals. CTRL^C will
  145.     cause it to terminate instantly, CTRL^E will cause a
  146.     restart (with reloading the executable) and CTRL^F will
  147.     cause the server to output diagnostic stats into the
  148.     shell window.
  149.  
  150.  
  151. (7) Connecting several servers
  152.  
  153.     After running your local server, use the command "CLChatLink"
  154.     to connect to a different server. Usage is
  155.     CLChatLink <remoteservername> <remoteport> [retrycount]
  156.  
  157.     The retrycount is optional; if specified, CLChatLink will
  158.     retry a connection until the count runs out. If a already
  159.     successfully established connection break, retries start
  160.     back from 1.
  161.  
  162.     Note that the server-server protocol is quite bandwidth
  163.     expensive, so you should *NOT* create a server for single
  164.     users only.
  165.  
  166.     Note that nicknames must be unique on all servers; if servers
  167.     connect and a nick collision occurs, both users are removed
  168.     from their correspondending servers and a nick collision
  169.     message is broadcasted.
  170.  
  171.     Server loops may be created; every server message carries
  172.     a unique messageid which will be checked by every server
  173.     it passes; dupes are filtered out. Server loops may raise
  174.     broadcast speed esspecially on slow network connections.
  175.     The server uses some kind of smart routing for private
  176.     messages: if the destination of a private message is on a
  177.     directly linked server, the message is send to this
  178.     server only. If not, it is broadcasted, so no routing
  179.     tables are necessary.
  180.  
  181.  
  182. (8) History:
  183.  
  184.     See the CLChatGUI.(doc|guide) for more specific GUI
  185.     client revision information.
  186.  
  187.     Release 3.0
  188.     -----------
  189.     - the server now uses smart routing for private messages;
  190.       if the destination server is a direct link, no broadcast
  191.       is produced
  192.     - added user banning capabilities
  193.     - added /NETINFO server inquiry broadcast
  194.     - added chat operator command output on /HELP if the
  195.       use is a chat operator.
  196.     - made /SERVERS command available to normal chat users
  197.     - updated CLChatLink to correctly fill in the remote
  198.       server name.
  199.     - extended server msgs with a message id tag to filter
  200.       message dupes produced by server loops.
  201.  
  202.     Release 3.1
  203.     -----------
  204.     - everything is now compiled with SAS/C 6.55. Also added
  205.       server version directly compiled for 68030 CPUs.
  206.     - added more detailed NETINFO output.
  207.     - added /STAT command for chat operators. Also "/STAT *"
  208.       broadcasts /STAT requests via net.
  209.     - extended /USERS command with "S" option to display
  210.       users with the servers they're on.
  211.     - added /RESTART command for chat operators to have
  212.       the server restart itself. Also CTRL^E will cause
  213.       a restart.
  214.     - added CTRL^F response displaying server stats to
  215.       the shell.
  216.     - fixed CLChatLink and CLChatD to fill in the IP
  217.       address of remote servers for the /SERVERS command
  218.       output.
  219.     - fixed smart privmsg routing.
  220.     - fixed user removement for flood protection and
  221.       /KILL commands.
  222.     - fixed may GUI client bugs & quirks.
  223.     - GUI client now has IP file transfer option similar
  224.       to DCC
  225.     - GUI client now has a PING option to test links
  226.       from user to user directly
  227.     - fixed bug in the server which caused a stack
  228.       overwrite on privmsgs > 230 bytes
  229.     - both CLChatD and CLChatLink are now "pure" code
  230.       and can be made resident for more efficient memory
  231.       usage
  232.  
  233.     Release 3.2
  234.     -----------
  235.     - fixed local /STAT output to report only local
  236.       users
  237.     - fixed server validation bug; checked IP addresse instead
  238.       of FQDN
  239.     - fixed server reject error message
  240.     - cleaned up GUI client scroller handling
  241.     - added PLUBOT sample code
  242.  
  243.  
  244.     Release 3.3
  245.     -----------
  246.     - CLChatLink was seriously broken; retry didn't worked
  247.       and broken active links causes server crashes due to
  248.       illegal messages.
  249.     - increased stacksizes or reduced stack usage in all parts
  250.       of the package due to frequent crashes on some setups.
  251.     - some GUI client cleanup.
  252.  
  253.     Release 3.4
  254.     -----------
  255.     - fixed some quirks in the GUI-Client
  256.     - fixed time bug in the CLChatServer
  257.  
  258.     Release 3.6
  259.     -----------
  260.     - did some work on the CLChatGUI-Client (see history)
  261.     - added MS-Windows client (clchatwi.LZH).
  262.     - new chat operator command /NOTICE.
  263.     - logfile option: if a file AmiTCP:Log/ChatServer.LOG
  264.       exists, the chat server will log all outgoing
  265.       messages with that file.
  266.     - cleaned up /MSG to send the acknowledge msg before
  267.       the destination message.
  268.     - fixed several typos.
  269.     - CLChatLink now no longer needs the port arguments,
  270.       but defaults to 5555.
  271.  
  272.    Release 3.7
  273.    -----------
  274.    - added installer script by Robert Reiswig (rcr@netcom.com)
  275.  
  276.  
  277. (9) ARCnet
  278.  
  279.     There is already a public Internet chat network based on
  280.     CLChat called the "ARCnet" (Amiga Relay Chat Network).
  281.     See the client documentation for up-to-date information
  282.     about this network and servers you can connect to.
  283.  
  284.  
  285. (10) Thanks must go to:
  286.  
  287.      Roy Millican  - for encouragement and running the first
  288.                      public CLChat server on the InterNet ;-)
  289.  
  290.      James Atwill, Ralf Deifel
  291.                    - for their help during multi server testing
  292.  
  293.      Jeremiah S. Junken
  294.                    - for the CLChatGUI icon
  295.  
  296.      Robert Reiswig
  297.                    - for the Installer script
  298.